エクステンション定義

概要

エクステンション定義では、エクステンション全体に関わる情報を定義します。

エクステンション定義の要素

キー 値の説明
必須か
name すべてのエクステンションで一意となる任意の名前。 必須
displayName エクステンションの表示名1 -
description エクステンションの説明1 -
icon エクステンションのアイコン1 -
version エクステンションのバージョン1 -
publisher エクステンションの提供元1 -
license エクステンションのライセンス1 -
homepage エクステンションに関するホームページのURL1 -
categories エクステンションが属するカテゴリ名の配列1 -
env エクステンションの動作環境1 -
main 実行プログラムのエントリーポイントとなるファイル名(スクリプトもしくはDLL) 必須
lifecycle エクステンションのライフサイクル。 application, project のいずれか。 必須
baseprofile エクステンションが有効となるプロジェクトのプロファイル名。baseprofile の設定がない場合、もしくは、値が * の場合はすべてのプロジェクトで有効。複数のプロファイルで有効となる場合はカンマ区切りでそれらのプロファイルを列挙します。 -
extensionPoints エクステンションの拡張ポイント定義 -

定義例

ライフサイクルごとの定義例

アプリケーションライフサイクルの場合

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Hello World を画面表示します。",
    "icon": "resources/About.png",
    "version": "1.1.0",
    "publisher": "DENSO CREATE INC",
    "license": "Next Design 使用許諾契約書に準ずる。Copyright (C) 2019 DENSO CREATE INC.",
    "homepage": "http://www.denso-create.jp",
    "categories": [ "共通" ],
    "env": {
        "nextdesign": "1.1.0"
    },

    "main": "entrypoint.cs",
    "lifecycle": "application",     // アプリケーションライフサイクル

    "extensionPoints": {
        ...
    }
}

プロジェクトライフサイクルの場合

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Hello World を画面表示します。",
    "icon": "resources/About.png",
    "version": "1.1.0",
    "publisher": "DENSO CREATE INC",
    "license": "Next Design 使用許諾契約書に準ずる。Copyright (C) 2019 DENSO CREATE INC.",
    "homepage": "http://www.denso-create.jp",
    "categories": [ "共通" ],
    "env": {
        "nextdesign": "1.1.0"
    },

    "main": "entrypoint.cs",
    "lifecycle": "project",               // プロジェクトライフサイクル
    "baseprofile": "対象プロファイル名",    // エクステンションが有効となるプロジェクトのプロファイル名

    "extensionPoints": {
        ...
    }
}

実装方法ごとの定義例

C# スクリプトの場合

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Hello World を画面表示します。",
    "icon": "resources/About.png",
    "version": "1.1.0",
    "publisher": "DENSO CREATE INC",
    "license": "Next Design 使用許諾契約書に準ずる。Copyright (C) 2019 DENSO CREATE INC.",
    "homepage": "http://www.denso-create.jp",
    "categories": [ "共通" ],
    "env": {
        "nextdesign": "1.1.0"
    },

    "main": "main.cs",          // スクリプトファイルを指定
    "lifecycle": "project",
    "baseprofile": "対象プロファイル名",

    "extensionPoints": {
        ...
    }
}

.NET DLLの場合

{
    "name": "HelloWorld",
    "displayName": "Hello World",
    "description": "Hello World を画面表示します。",
    "icon": "resources/About.png",
    "version": "1.1.0",
    "publisher": "DENSO CREATE INC",
    "license": "Next Design 使用許諾契約書に準ずる。Copyright (C) 2019 DENSO CREATE INC.",
    "homepage": "http://www.denso-create.jp",
    "categories": [ "共通" ],
    "env": {
        "nextdesign": "1.1.0"
    },

    "main": "helloworld.dll",   // DLL ファイルを指定
    "lifecycle": "project",
    "baseprofile": "対象プロファイル名",

    "extensionPoints": {
        ...
    }
}

    • 現バージョンではエクステンションの動作に影響せず表示もされません。